package xx.services.entity.inter;

import javax.ws.rs.FormParam;
import javax.ws.rs.PathParam;

/**
 * 评论私有服务接口
 * 
 * @Path (Constants.RESTFUL_MANAGE_PATH + "/comment")
 * @author chenxiang
 */
public interface ICommentInterface
{
    /**
     * 获取对评论{comment_id}的回复列表。
     * 
     * @GET
     * @Path ("/{comment_id}/reply")
     * @param commentId-@PathParam("comment_id")
     *            评论ID
     * @return 回复列表
     * @author dengjinye,2010-10-29
     */
    public String getReplyList(@PathParam("comment_id")
    long commentId);

    /**
     * 为实体评论{comment_id}增加一条回复。
     * 
     * @POST
     * @Path ("/{comment_id}/reply")
     * @param commentId-@PathParam("comment_id")
     *            评论ID
     * @param title-@FormParam("title")
     *            回复标题
     * @param content-@FormParam("content")
     *            回复内容
     * @return 新增的回复实体
     * @author dengjinye,2010-10-29
     */
    public String addReply(@PathParam("comment_id")
    long commentId, @FormParam("title")
    String title, @FormParam("content")
    String content);

    /**
     * 修改评论{comment_id}的标题内容等。
     * 
     * @PUT
     * @Path ("/{comment_id}")
     * @param commentId-@PathParam("comment_id")
     *            评论ID
     * @param title-@FormParam("title")
     *            标题
     * @param content-@FormParam("content")
     *            内容
     * @param readed-@FormParam("readed")
     *            是否已读
     * @return 返回新的评论
     * @author dengjinye,2010-10-29
     */
    public String updateComment(@PathParam("comment_id")
    long commentId, @FormParam("title")
    String title, @FormParam("content")
    String content,@FormParam("readed")
    boolean readed);

    /**
     * 删除评论{comment_ids}集，同时删除与之关联的回复。
     * 
     * @DELETE
     * @Path ("/{comment_id}")
     * @param commentId-@PathParam("comment_id")
     *            评论ID，多个ID用“_”隔开
     * @return
     * @author dengjinye,2010-10-29
     */
    public String deleteComment(@PathParam("comment_id")
    String commentId);
}
